package com.moss.cloud.base.biz.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.moss.cloud.base.api.model.from.BaseFrom;
import com.moss.cloud.base.api.model.from.ChildrenFrom;
import com.moss.cloud.base.api.model.from.RegionFrom;
import com.moss.cloud.base.api.model.param.RegionTreeParam;
import com.moss.cloud.base.biz.model.SysProvinces;
import com.moss.cloud.common.core.model.vo.RegionTreeVO;

import java.util.List;

/**
 * 全国行政区划业务接口
 *
 * @author 瑾年
 * @date 2023年12月2日
 */
public interface ISysProvincesService extends IService<SysProvinces> {

    /**
     * 数据缓存初始化
     *
     * @return
     */
    List<RegionTreeVO> loadProvinces();

    /**
     * 查询行政区划数据
     *
     * @return
     */
    List<RegionTreeVO> regionTrees();

    /**
     * 查询行政区划数据
     *
     * @return
     */
    IPage<RegionTreeVO> regionPageTree(RegionTreeParam param);

    /**
     * 查询行政区子集数据查询
     *
     * @param childrenFrom
     * @return
     */
    List<RegionTreeVO> regionChildren(ChildrenFrom childrenFrom);

    /**
     * 新增行政区划
     *
     * @param regionFrom
     * @return
     */
    Boolean saveRegion(RegionFrom regionFrom);

    /**
     * 编辑行政区划
     *
     * @param regionFrom
     * @return
     */
    Boolean updateRegion(RegionFrom regionFrom);

    /**
     * 删除行政区划
     *
     * @param baseFrom
     * @return
     */
    Boolean removeRegion(BaseFrom baseFrom);
}
